Adds Flagsmith adapter

[tiagoapolo]

This pull request introduces a new provider adapter for the Flags SDK that integrates with Flagsmith. The changes include adding configuration files, updating dependencies, and creating the necessary code for the adapter.

Flagsmith documentation: https://docs.flagsmith.com/clients/next-ssr

Usage

import { createFlagsmithAdapter } from '@flags-sdk/adapter-flagsmith';
import { flag } from 'flags';

// Create the Flagsmith adapter
const flagsmithAdapter = createFlagsmithAdapter({
  environmentID: 'your-environment-id',
  // Optional: Add any other Flagsmith configuration options
  // See: https://docs.flagsmith.com/clients/javascript/
});

// Define your flags
const myFeatureFlag = flag({
  key: 'my-feature',
  adapter: flagsmithAdapter,
});

// Use the flag in your application
const flag = await myFeatureFlag();

[vercel]

@tiagoapolo is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	flagsmith@​9.0.5

View full report

[dferber90]

Thank you for your contributions so far! I left a bit of early guidance

[dferber90]

Do you work for Flagsmith? If we merge this PR we'd also put up some actual docs on flags-sdk.dev. Would you be wiling to link to our Flags SDK and those docs from https://docs.flagsmith.com?

[matthewelwell]

Hey @dferber90, just jumping in here since Tiago is on vacation - yes, Tiago works for Flagsmith.

In answer to your question, for sure, we'd be happy to link to your docs from https://docs.flagsmith.com - would you be happy with adding reciprocal backlink(s) too?

[dferber90]

Great! We'd add you to https://flags-sdk.dev/providers and create a docs page for FlagSmith

[tiagoapolo]

@dferber90 could you take one more look at my PR ?

[dferber90]

@tiagoapolo I‘m out of office this week, but @AAorris will take over leading adapter work and help you get this finalized, listed and released 👍

[AAorris]

Thanks for your PR! Please consider the following input:

Strongly recommended:

• Support identity through entities
• Optimize performance for multiple features in one request

Recommended:

• Add origin to link flags to your customers' dashboards

[AAorris]

The progress here is looking good!

It looked ready enough while reviewing that I started to explore an example app using the adapter. However, I found several issues while testing in an app.

To continue the review with me, please develop an example that uses the adapter based on an existing one

• Standard templates: https://github.com/vercel/examples/tree/main/flags-sdk
• The slim template I branched for testing with Flagsmith

You can build, test, and deploy the demo using your local adapter code by following these instructions

Please share a link to the example app with your next review request. I look forward to it!

[tiagoapolo]

@AAorris in this branch you have my example running https://github.com/tiagoapolo/examples/tree/flagsmith-adapter. Also it's deployed in vercel at: https://flags-sdk-template-ff5v5lyuk-tiagos-projects-e9d5728f.vercel.app/
Here's quick demo:

flags_compressed.mov

[AAorris]

Hi @tiagoapolo, thanks for your work and sorry for the delay. I'm back and will be reviewing this week if possible.

I don't see your code pushed up to the branch, could you make sure it's available for me to reproduce?

It would be great if the example shows how to replicate the flags in the same way as other examples:

• Free Delivery: 50% staged feature rollout by ID
• Summer Sale: 50% staged feature rollout by ID
• Proceed to Checkout: "red" | "green" | "blue" multivariant string staged 33% each by ID
• Dev tools widget is able to update the ID to see different variants

[tiagoapolo]

Hi @tiagoapolo, thanks for your work and sorry for the delay. I'm back and will be reviewing this week if possible.

I don't see your code pushed up to the branch, could you make sure it's available for me to reproduce?

It would be great if the example shows how to replicate the flags in the same way as other examples:

• Free Delivery: 50% staged feature rollout by ID
• Summer Sale: 50% staged feature rollout by ID
• Proceed to Checkout: "red" | "green" | "blue" multivariant string staged 33% each by ID
• Dev tools widget is able to update the ID to see different variants

Hi @AAorris I'll add an example replicating that and let you know once it's available.

[tiagoapolo]

Hi @tiagoapolo, thanks for your work and sorry for the delay. I'm back and will be reviewing this week if possible.

I don't see your code pushed up to the branch, could you make sure it's available for me to reproduce?

It would be great if the example shows how to replicate the flags in the same way as other examples:

• Free Delivery: 50% staged feature rollout by ID
• Summer Sale: 50% staged feature rollout by ID
• Proceed to Checkout: "red" | "green" | "blue" multivariant string staged 33% each by ID
• Dev tools widget is able to update the ID to see different variants

• Free Delivery

@AAorris is the split done on your end?

[AAorris]

The split is usually done in the flag provider, ex. a feature flag with "a percentage rollout based on distinct user IDs" configured in your dashboard, or "an A/B test with 50% allocation to the test variant"

[tiagoapolo]

The split is usually done in the flag provider, ex. a feature flag with "a percentage rollout based on distinct user IDs" configured in your dashboard, or "an A/B test with 50% allocation to the test variant"

Thanks @AAorris, new example created. I was able to run it locally but I had issues when deploying it to vercel, can you check if there's anything not properly set?
vercel/examples#1144

[AAorris]

👋 I'm out of office right now so I'll look for assistance from the team in continuing to review

[chriswdmr]

Thanks for your patience, I just had a look!

You can find my review for the example here: vercel/examples#1144 (review)

Have you planned adding some docs for the Flags SDK adapter on your end? I was unable to find them on your site.

I noticed that you used environmentID and projectID (with a capital "D"). It's just a nitpick, but our other providers use standard camel casing.

We handle the CHANGELOG.md automatically for you, you can remove it and just run the changeset command and commit the outputs

[tiagoapolo]

Thanks for your patience, I just had a look!

You can find my review for the example here: vercel/examples#1144 (review)

Have you planned adding some docs for the Flags SDK adapter on your end? I was unable to find them on your site.

I noticed that you used environmentID and projectID (with a capital "D"). It's just a nitpick, but our other providers use standard camel casing.

We handle the CHANGELOG.md automatically for you, you can remove it and just run the changeset command and commit the outputs

Hi @chriswdmr, thank you for reviewing it. My plan is to add documentation on our side about Flags SDK at https://docs.flagsmith.com/ and we agreed with @dferber90 to have a back link to vercel flags docs on our docs and to have a link to flagsmith docs on your docs. I also updated the variables to camel case

[tiagoapolo]

@chriswdmr can you do a final review on this one?

[dferber90]

We don't need to make a new release of the flags package

Suggested change

	'flags': minor
	-'flags': minor

[dferber90]

Since flagsmith is a singleton, does this mean there can only ever be one instance of the adapter at the same time?

If it gets called twice to connect to different projects the first adapter would get reconfigured, right?

That could be quite surprising, but I'm fine with this if we document it

const adapterA = createFlagsmithAdapter(projectA)
const adapterB = createFlagsmithAdapter(projectB)

Due to the singleton adapterA would now also connect to projectB 🐛

[dferber90]

Merging so we can test directly within this repo

[dferber90]

I merged this today with the intention of testing and releasing but I ran out of time. Will pick this back up again next week. It is merged but unreleased for now.

[dferber90]

I reverted briefly as we needed to merge something else and I did not get around to review yet.

[dferber90]

Continuing this in #167