SunbirdEd-portal local installation

[ravishtrigyn]

I was trying to setup SunbirdEd-portal locally based on documentation at https://github.com/Sunbird-Ed/SunbirdEd-portal/tree/release-5.1.0.

Prerequisites satisfied

• System Requirements matched.
• Software dependencies fulfilled.

Setup steps followed

• Installed required dependencies for web application at {PROJECT-FOLDER}/src/app/client.
• Installed required dependencies for backend API interface at {PROJECT-FOLDER}/src/app.

Error observed
Installation is failing for following dependency, while installing packages for backend API interface:
"keycloak-connect": "git+https://github.com/project-sunbird/keycloak-nodejs-connect.git#release-2.5.0",
Error message says -
➤ YN0058: │ keycloak-connect@https://github.com/project-sunbird/keycloak-nodejs-connect.git#commit=7a69f6d5a90ace385fce1eedb452d9edfc1538af: Packing the package failed (exit code 128, logs can be found here:

Logs details
Logs point to a broken dependency related to bucharest-gold/keycloak-admin.
Exact error says-
Could not fetch metadata for keycloak-admin-client@git+ssh://git@github.com/bucharest-gold/keycloak-admin-client.git#1251b8d29a141e7b568e7a2fcef41527870d1d30

Can you please provide resolution to this problem?

[gandham-santhosh]

@rajeevsathish @rajeshkumaravel can you please check this?
@ravishtrigyn can you please let me know why you would like to setup portal in your local box? Usually when someone is contributing/developing to Sunbird features, they will fork this repo and setup the same in local box.

If you are trying to setup Sunbird Ed and experience the platform, please follow the installation instructions mentioned here https://ed.sunbird.org/use/installing-ed-platform/release-5.1.0

[rajeevsathish]

@ravishtrigyn as I tried to use the keycloak-connect in a separate independent project was able to download so please look this may a machine specific issue
"dependencies": {
"keycloak-connect": "git+https://github.com/project-sunbird/keycloak-nodejs-connect.git#release-2.5.0"
}
cc: @vinukumar-vs

[Krishnaj20]

@ravishtrigyn - Pls let us know if your query is resolved.

@anandvarada @gandham-santhosh @kameshbhr @vinukumar-vs

[ravishtrigyn]

@rajeevsathish Even when I created a new project afresh, with just this one dependency, I still got this error. Please have a look at the attached generated log file. error.log

From logs it is pretty easy to deduce that the dependent package "bucharest-gold/keycloak-admin-client" can not be fetched. You can try hitting github.com/bucharest-gold/keycloak-admin-client.git. You'll get 404.

Package.json looks as following-

{
  "name": "packagetest",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {
	  "keycloak-connect": "git+https://github.com/project-sunbird/keycloak-nodejs-connect.git#release-2.5.0"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

@Krishnaj20 @anandvarada Can you please help here?

[rajeshkumaravel]

@ravishtrigyn

• I have tried installing with only one dependencies "keycloak-connect": "git+https://github.com/project-sunbird/keycloak-nodejs-connect.git#release-2.5.0"
  Installation was successful.

npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN packagetest@1.0.0 No description
npm WARN packagetest@1.0.0 No repository field.

added 13 packages from 6 contributors and audited 13 packages in 5.089s

1 package is looking for funding
  run `npm fund` for details

found 0 vulnerabilities

• I have tried installing bucharest-gold/keycloak-admin-client, plugin installation was successful.

$ npm i keycloak-admin-client
npm WARN deprecated keycloak-admin-client@0.12.0: This library is no longer maintained and is replaced by https://github.com/keycloak/keycloak-nodejs-admin-client.
npm WARN deprecated request@2.88.2: request has been deprecated, see https://github.com/request/request/issues/3142
npm WARN deprecated har-validator@5.1.5: this library is no longer supported
npm WARN deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
npm WARN packagetest@1.0.0 No description
npm WARN packagetest@1.0.0 No repository field.

+ keycloak-admin-client@0.12.0
added 47 packages from 57 contributors and audited 60 packages in 3.763s

2 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

---

• I agree that accessing github repo for https://github.com/bucharest-gold/keycloak-admin-client gives 404 This is not the web page you are looking for
• However npm packages which are published and are live need not mandatorily required github account to be active
• The corresponding npm package URL - https://www.npmjs.com/package/keycloak-admin-client
• For reference, while installing the above said package I have shared logs which clearly mentions that the package is not maintained and has been moved / replaced to https://github.com/keycloak/keycloak-nodejs-admin-client

CC: @Krishnaj20 @vinukumar-vs @gandham-santhosh @rajeevsathish @anandvarada

[gandham-santhosh]

@ravishtrigyn please let us know if you are able to resolve at your end

[ravishtrigyn]

@gandham-santhosh @rajeshkumaravel @rajeevsathish
I was able to resolve the issue and install the dependencies at both {PROJECT-FOLDER}/src/app/client and {PROJECT-FOLDER}/src/app. Thanks for all your support.

It seems that lock file was corrupted and at the same time using same package manager for both the projects was causing issue. I used yarn for client and npm for app and it worked.

However, now when I try to run the apps for both client and server, though client is running fine, but server is throwing exception. I'm getting following error.
"uncaughtException: Contacts points are not defined.\nTypeError: Contacts points are not defined.\n at Object.extend (D:\\DIKSHA\\code\\SunbirdEd-portal\\src\\app\\node_modules\\cassandra-driver\\lib\\client-options.js:94:11)\n at new Client (D:\\DIKSHA\\code\\SunbirdEd-portal\\src\\app\\node_modules\\cassandra-driver\\lib\\client.js:328:32)\n at new CassandraStore (D:\\DIKSHA\\code\\SunbirdEd-portal\\src\\app\\node_modules\\cassandra-session-store\\lib\\cassandra-store.js:17:21)\n at Object.getCassandraStoreInstance (D:\\DIKSHA\\code\\SunbirdEd-portal\\src\\app\\helpers\\cassandraUtil.js:11:10)\n at Object.<anonymous> (D:\\DIKSHA\\code\\SunbirdEd-portal\\src\\app\\helpers\\keyCloakHelper.js:71:34)\n at Module._compile

It seems that some configuration is required for Cassandra. At present following config keys exist in my src\app\helpers\environmentVariablesHelper.js
'LEARNER_URL', 'CONTENT_URL', 'CONTENT_PROXY_URL', 'PORTAL_REALM', 'PORTAL_AUTH_SERVER_URL', 'PORTAL_AUTH_SERVER_CLIENT', 'PORTAL_PORT', 'PORTAL_ECHO_API_URL', 'PORTAL_API_AUTH_TOKEN'

Can you point me to missing config, so that I can run server as well? Thanks.

[ravishtrigyn]

I've added PORTAL_CASSANDRA_URLS, PORTAL_CASSANDRA_CONSISTENCY_LEVEL & PORTAL_CASSANDRA_REPLICATION_STRATEGY, but its still same error.

[gandham-santhosh]

@rajeevsathish please check this

[rajeevsathish]

@ravishtrigyn please put debuggers and see if the set variables are still able to get or you are facing some issue there?
as this looks like the variables are not set properly

[ravishtrigyn]

@rajeevsathish It seems I need vpn access to access the APIs configured. I'll update once I test with vpn access enabled.

[Krishnaj20]

@ravishtrigyn - I understand that there was a call set up with the Sunbird community to address this issue. Let us know if your query is now resolved. If it is resolved, request you to document the answer in this thread and mark it as answered.

@anandvarada @madhucr

[ravishtrigyn]

@Krishnaj20, It seems that there are more environment variables needed. After I completed local installation of Cassandra and changed required config, now server is looking for KEYCLOAK_GOOGLE_CLIENT details. As per documentation at https://ed.sunbird.org/use-1/configuration/sunbirded-portal and https://github.com/Sunbird-Ed/SunbirdEd-portal/tree/release-5.1.0, we dont have any instructions for keycloak client.

Can you please point me to suitable Keycloak client setup and configuration required? Thanks.

Error is as following-
"date":"Tue Feb 14 2023 11:27:15 GMT+0530 (India Standard Time)","error":{},"exception":true,"level":"error","message":"uncaughtException: Cannot read properties of undefined (reading 'clientId')\nTypeError: Cannot read properties of undefined (reading 'clientId')\n at Object.<anonymous> (D:\\DIKSHA\\code\\SunbirdEd-portal\\src\\app\\helpers\\userService.js:6:46)\n

@anandvarada

[vinukumar-vs]

@ravishtrigyn If you refer to userService.js:6:46 code, it's clearly saying our configuration object(KEYCLOAK_GOOGLE_CLIENT) doesn't have "clientId"(envHelper.KEYCLOAK_GOOGLE_CLIENT.clientId,). Hence it is giving the above error.

const keyCloakClient = getKeyCloakClient({
resource: envHelper.KEYCLOAK_GOOGLE_CLIENT.clientId,
bearerOnly: true,
serverUrl: envHelper.PORTAL_AUTH_SERVER_URL,
realm: envHelper.PORTAL_REALM,
credentials: {
secret: envHelper.KEYCLOAK_GOOGLE_CLIENT.secret
}
});

Please verify your object structure follows as below
https://github.com/Sunbird-Ed/SunbirdEd-portal/blob/release-5.1.0/src/app/helpers/environmentVariablesHelper.js#L77

KEYCLOAK_GOOGLE_CLIENT: {
clientId: env.sunbird_google_keycloak_client_id,
secret: env.sunbird_google_keycloak_secret
},

@Krishnaj20 @rajeevsathish @anandvarada @gandham-santhosh

[vinukumar-vs]

@ravishtrigyn is it working with above configuration updated with right values?

@Krishnaj20 @anandvarada

[ravishtrigyn]

@vinukumar-vs I'm still waiting for the required KEYCLOAK_GOOGLE_CLIENT config from concerned team. Once its done, I'll run server again and update this thread.

[ravishtrigyn]

@vinukumar-vs @Krishnaj20
Now after having the required config for keycloak, relevant issue is resolved, but I'm facing this new issue-
{"date":"Thu Feb 23 2023 10:08:23 GMT+0530 (India Standard Time)","error":{"code":"MODULE_NOT_FOUND","message":"Cannot find module './jwtHelper'\nRequire stack:\n- D:\\DIKSHA\\code\\SunbirdEd-portal\\src\\app\\helpers\\googleOauthHelper.js\n- D:\\DIKSHA\\code\\SunbirdEd-portal\\src\\app\\routes\\googleSignInRoutes.js\n- D:\\DIKSHA\\code\\SunbirdEd-portal\\src\\app\\server.js",

There is no local file for jwtHelper module, in the repo. Should I instead try with https://www.npmjs.com/package/jwthelper?

[vinukumar-vs]

@ravishtrigyn I hope these issues are resolved while participating in the Bootcamp(Mar 2023). Please confirm.

[ravishtrigyn]

@vinukumar-vs I guess you already are aware that we could not get our issues resolved in bootcamp. We had build issues and even your team at bootcamp was not able to resolve the issues.

[rajeevsathish]

@ravishtrigyn
As we are aware you and your team was able to setup Sunbird locally and also point to staging and run the application locally.
Your team was successful in learning and solving the tasks defined in the bootcamp dev agenda.
The issue you are mentioning / facing is not related to Sunbird, issue is with NodeJS and Windows machine as this is out of our scope and this has to be addressed by individual developer.

cc: @vinukumar-vs @Krishnaj20 @chitranshu-keshav @madhucr @rajeshkumaravel @abhishekpnt

[ravishtrigyn]

@rajeevsathish We were able to run locally but only with limited functionality. Login was not working and no-one was able to provide a solution for this. I doubt if it was a Windows issue. It looked more like access issue on Staging env.

However, I agree that Sunbird-Ed development isn't best suited for Windows machine. I wish, if Sunbird would mention the same on documentation. That would be useful for all the developers trying to install it locally.

[vinukumar-vs]

@ravishtrigyn Thanks for logging the windows specific issues. In Sunbird community Bootcamp also we have noticed many people are struggled with Windows machine to setup.

Please find the below thread for windows installation.
#433

Thanks @rajeevsathish for addressing the windows installation issue.
@Krishnaj20 @pallakartheekreddy @chitranshu-keshav @gandham-santhosh @reshmi-nair @vrayulu @anandvarada @madhucr

[ravishtrigyn]

@vinukumar-vs @rajeevsathish I tried with suggested steps in https://github.com/orgs/Sunbird-Ed/discussions/433, but it did not help with my existing issues. Can we arrange a call where we can look at the issues in my local (windows specific or otherwise)?

CC @anandvarada

[chitranshu-keshav]

marking this thread a answered since there is no activity since 3 weeks

[ravishtrigyn]

Marking as un-answered as the issue still exists.

[rajeevsathish]

@ravishtrigyn as we have a session on 19th for windows installation can we see this issue there? or post that session we can see if we need a call

[rajeevsathish]

@ravishtrigyn hope the session on Installing SunbirdED portal in windows 11 was useful and solved your issue you can see the recording of the session in this thread https://github.com/orgs/Sunbird-Ed/discussions/463
cc: @vinukumar-vs @Krishnaj20 @chitranshu-keshav

[Krishnaj20]

@ravishtrigyn - Let us know if your queries are addressed?