Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LiveShare SDK does not work in SPFx web part #8705

Closed
2 of 9 tasks
canturan opened this issue Jan 18, 2023 · 6 comments
Closed
2 of 9 tasks

LiveShare SDK does not work in SPFx web part #8705

canturan opened this issue Jan 18, 2023 · 6 comments
Labels
area:spfx Category: SharePoint Framework (not extensions related) status:working-on-it Known issue / feature being addressed. Will use other "status:*" labels & comments for more detail. type:bug-confirmed Confirmed bug, not working as designed / expected.
Milestone

Comments

@canturan
Copy link

Target SharePoint environment

SharePoint Online

What SharePoint development model, framework, SDK or API is this about?

💥 SharePoint Framework

Developer environment

None

What browser(s) / client(s) have you tested

  • 💥 Internet Explorer
  • 💥 Microsoft Edge
  • 💥 Google Chrome
  • 💥 FireFox
  • 💥 Safari
  • mobile (iOS/iPadOS)
  • mobile (Android)
  • not applicable
  • other (enter in the "Additional environment details" area below)

Additional environment details

  • SPFx version: 1.16.1

Describe the bug / error

I was trying to use LiveShare SDK for a SPFx Teams Meeting app, which is the best actual way to create collaborative multi-user experiences without writing any dedicated back-end code or using legacy technologies, which I failed.

The SPFx initializes currently teams-js the v2.4.2. The LiveShare SDK has a hard dependency of the teams-js v2.5.0 (because of the LiveShareHost class in the teams-js v2.5.0, which is missing in the v2.4.2). I tried to install the teams-js v2.5.0 using a npm alias (I am aware that it is documented and unsupported to have multiple version of the teams-js in a SPFx solution). This has worked. I could also initialize the teams-js ( app.initialize() ) without any problem. But as soon as I initialize a LiveShare container, my web part does not load at all with the following error.

image

After some analysis and exchange with the LiveShare team: It looks like the way that teams-js works is pretty much incompatible with having multiple versions installed and initialized at once.

The only possible solution to that is to update the teams-js to v2.5.0 which SPFx loader loads and initializes.

The apps in the meetings should allow users to collaborate seamlessly during the meetings and calls. Without the LiveShare, the developers should either use legacy technologies or invest much time to write back-end code, if they would want to use SPFx for meeting apps. To summarize: It would not make much sense to use SPFx right now to create collaborative Teams meeting apps.

My main question is: Is there any plan to upgrade teams-js in SPFx to v2.5.0 anytime soon? @VesaJuvonen @patmill @lucabandMSFT @AJIXuMuK

Thank you all in advance!!!

Steps to reproduce

  1. Create a SPFx solution
  2. Install LiveShare SDK
  3. Initialize a LiveShare container

Expected behavior

It took like 1 year that we can use the meeting stage with SPFx because of the bugs in Teams and SPFx site. Because of that I am hoping and expecting that we can use LiveShare SDK in meeting apps soon (Upgrade to teams-js v2.5.0) and it would not take long like the meeting stage fix.

@canturan canturan added the type:bug-suspected Suspected bug (not working as designed/expected). See “type:bug-confirmed” for confirmed bugs. label Jan 18, 2023
@ghost
Copy link

ghost commented Jan 18, 2023

Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible.

@ghost ghost added the Needs: Triage 🔍 Awaiting categorization and initial review. label Jan 18, 2023
@lucabandMSFT lucabandMSFT added this to the 1.17.0 milestone Jan 18, 2023
@lucabandMSFT lucabandMSFT added status:fixed-next-drop Issue planned to be fixed in an upcoming release. type:bug-confirmed Confirmed bug, not working as designed / expected. and removed type:bug-suspected Suspected bug (not working as designed/expected). See “type:bug-confirmed” for confirmed bugs. Needs: Triage 🔍 Awaiting categorization and initial review. labels Jan 18, 2023
@lucabandMSFT
Copy link
Collaborator

@canturan , thanks. We are going to bump the version of Teams SDK in the next drop of SPFx

@AJIXuMuK AJIXuMuK added area:spfx Category: SharePoint Framework (not extensions related) status:working-on-it Known issue / feature being addressed. Will use other "status:*" labels & comments for more detail. and removed status:fixed-next-drop Issue planned to be fixed in an upcoming release. labels Jan 19, 2023
@canturan
Copy link
Author

canturan commented Mar 8, 2023

Hi @lucabandMSFT,
I have checked the 1.17 beta today. The Teams SDK version is still the 2.4.2. When should we expect the version upgrade of Teams SDK? on the GA package?
Thanks!!!

@AJIXuMuK
Copy link
Collaborator

AJIXuMuK commented Mar 8, 2023

@canturan - it will be included in the next beta package

@AJIXuMuK
Copy link
Collaborator

Included in beta.3

@ghost
Copy link

ghost commented Apr 8, 2023

Issues that have been closed & had no follow-up activity for at least 7 days are automatically locked. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: Issue List: Our approach to locked issues

@SharePoint SharePoint locked as resolved and limited conversation to collaborators Apr 8, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area:spfx Category: SharePoint Framework (not extensions related) status:working-on-it Known issue / feature being addressed. Will use other "status:*" labels & comments for more detail. type:bug-confirmed Confirmed bug, not working as designed / expected.
Projects
None yet
Development

No branches or pull requests

3 participants