Skip to content

Commit

Permalink
fix: google onetap example (#679)
Browse files Browse the repository at this point in the history
* fix: google onetap example

* fix: cleanup

* fix: updated onetap example

* fix: updated onetap example

* fix: updated onetap example

* fix: minor fixes

* fix: removed google on frontend

* changes

---------

Co-authored-by: rishabhpoddar <rishabh.poddar@gmail.com>
  • Loading branch information
sattvikc and rishabhpoddar committed May 1, 2023
1 parent 40af56e commit e3ca010
Show file tree
Hide file tree
Showing 39 changed files with 1,364 additions and 0 deletions.
1 change: 1 addition & 0 deletions examples/with-thirdparty-google-onetap/.gitignore
@@ -0,0 +1 @@
node_modules/
45 changes: 45 additions & 0 deletions examples/with-thirdparty-google-onetap/README.md
@@ -0,0 +1,45 @@
![SuperTokens banner](https://raw.githubusercontent.com/supertokens/supertokens-logo/master/images/Artboard%20%E2%80%93%2027%402x.png)

# SuperTokens Google one tap Demo app

This demo app demonstrates the following use cases:

- Thirdparty Login / Sign-up using google one tap
- Logout
- Session management & Calling APIs

## Project setup

Clone the repo, enter the directory, and use `npm` to install the project dependencies:

```bash
git clone https://github.com/supertokens/supertokens-auth-react
cd supertokens-auth-react/examples/with-thirdparty-google-onetap
npm install
cd frontend && npm install && cd ../
cd backend && npm install && cd ../
```

## Run the demo app

This compiles and serves the React app and starts the backend API server on port 3001.

```bash
npm run start
```

The app will start on `http://localhost:3000`

## How it works

- The overall flow is that google returns an ID token to the frontend post login. This ID token is then sent to the backend, which then verifies the token and creates a supertokens user for ths user along with their session.
- This demo uses the pre build UI, but you can always build you own UI instead. For the pre built UI, we override the provider list UI to add the google one tab UI and provide it a callback handler which calls the supertokens' backend API with the id token. You can see how this is done in `App.tsx` file in the `frontend` folder, in the `doLogin` callback function.
- On the backend, we override the sign in up API from supertokens in which we call Google's API to verify the ID token and get info from it (it can also be done using a JWT verification library). After we have the user's info, we call the original implementation with the info to login the user.

## Author

Created with :heart: by the folks at supertokens.com.

## License

This project is licensed under the Apache 2.0 license.
115 changes: 115 additions & 0 deletions examples/with-thirdparty-google-onetap/backend/config.ts
@@ -0,0 +1,115 @@
import ThirdParty, { TypeProvider } from "supertokens-node/recipe/thirdparty";
import Session from "supertokens-node/recipe/session";
import { TypeInput } from "supertokens-node/types";
import Dashboard from "supertokens-node/recipe/dashboard";
import { TypeProviderGetResponse } from "supertokens-node/lib/build/recipe/thirdparty/types";
import axios from "axios";

export function getApiDomain() {
const apiPort = process.env.REACT_APP_API_PORT || 3001;
const apiUrl = process.env.REACT_APP_API_URL || `http://localhost:${apiPort}`;
return apiUrl;
}

export function getWebsiteDomain() {
const websitePort = process.env.REACT_APP_WEBSITE_PORT || 3000;
const websiteUrl = process.env.REACT_APP_WEBSITE_URL || `http://localhost:${websitePort}`;
return websiteUrl;
}

export function GoogleOneTap(config: any): TypeProvider {
const googleProvider = ThirdParty.Google(config);
return {
...googleProvider,
get: (
redirectURI: string | undefined,
authCodeFromRequest: string | undefined,
userContext: any
): TypeProviderGetResponse => {
const originalGet = googleProvider.get(redirectURI, authCodeFromRequest, userContext);
return {
...originalGet,
getProfileInfo: async (authCodeResponse: any, userContext: any) => {
return {
id: authCodeResponse.sub,
email: {
id: authCodeResponse.email,
isVerified: authCodeResponse.email_verified.toLowerCase() === "true",
},
};
},
};
},
};
}

export const SuperTokensConfig: TypeInput = {
supertokens: {
// this is the location of the SuperTokens core.
connectionURI: "https://try.supertokens.com",
},
appInfo: {
appName: "SuperTokens Demo App",
apiDomain: getApiDomain(),
websiteDomain: getWebsiteDomain(),
},
// recipeList contains all the modules that you want to
// use from SuperTokens. See the full list here: https://supertokens.com/docs/guides
recipeList: [
ThirdParty.init({
signInAndUpFeature: {
providers: [
// We have provided you with development keys which you can use for testing.
// IMPORTANT: Please replace them with your own OAuth keys for production use.
GoogleOneTap({
clientId: "1060725074195-kmeum4crr01uirfl2op9kd5acmi9jutn.apps.googleusercontent.com",
clientSecret: "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",
}),
ThirdParty.Github({
clientId: "467101b197249757c71f",
clientSecret: "e97051221f4b6426e8fe8d51486396703012f5bd",
}),
ThirdParty.Apple({
clientId: "4398792-io.supertokens.example.service",
clientSecret: {
keyId: "7M48Y4RYDL",
privateKey:
"-----BEGIN PRIVATE KEY-----\nMIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgu8gXs+XYkqXD6Ala9Sf/iJXzhbwcoG5dMh1OonpdJUmgCgYIKoZIzj0DAQehRANCAASfrvlFbFCYqn3I2zeknYXLwtH30JuOKestDbSfZYxZNMqhF/OzdZFTV0zc5u5s3eN+oCWbnvl0hM+9IW0UlkdA\n-----END PRIVATE KEY-----",
teamId: "YWQCXGJRJL",
},
}),
],
},
override: {
apis: (oI) => {
return {
...oI,
signInUpPOST: async (input) => {
if (oI.signInUpPOST !== undefined) {
if (input.provider.id === "google") {
const authCodeResponse = (
await axios.get("https://oauth2.googleapis.com/tokeninfo", {
params: {
id_token: input.code,
},
})
).data;
return await oI.signInUpPOST({
...input,
code: "",
authCodeResponse,
});
} else {
return await oI.signInUpPOST(input);
}
}
throw "API not enabled";
},
};
},
},
}),
Session.init(),
Dashboard.init(),
],
};
38 changes: 38 additions & 0 deletions examples/with-thirdparty-google-onetap/backend/index.ts
@@ -0,0 +1,38 @@
import express from "express";
import cors from "cors";
import supertokens from "supertokens-node";
import { verifySession } from "supertokens-node/recipe/session/framework/express";
import { middleware, errorHandler, SessionRequest } from "supertokens-node/framework/express";
import { getWebsiteDomain, SuperTokensConfig } from "./config";

supertokens.init(SuperTokensConfig);

const app = express();

app.use(
cors({
origin: getWebsiteDomain(),
allowedHeaders: ["content-type", ...supertokens.getAllCORSHeaders()],
methods: ["GET", "PUT", "POST", "DELETE"],
credentials: true,
})
);

// This exposes all the APIs from SuperTokens to the client.
app.use(middleware());

// An example API that requires session verification
app.get("/sessioninfo", verifySession(), async (req: SessionRequest, res) => {
let session = req.session;
res.send({
sessionHandle: session!.getHandle(),
userId: session!.getUserId(),
accessTokenPayload: session!.getAccessTokenPayload(),
});
});

// In case of session related errors, this error handler
// returns 401 to the client.
app.use(errorHandler());

app.listen(3001, () => console.log(`API Server listening on port 3001`));
29 changes: 29 additions & 0 deletions examples/with-thirdparty-google-onetap/backend/package.json
@@ -0,0 +1,29 @@
{
"name": "supertokens-node",
"version": "0.0.1",
"private": true,
"description": "",
"main": "index.js",
"scripts": {
"start": "npx ts-node-dev --project ./tsconfig.json ./index.ts"
},
"dependencies": {
"cors": "^2.8.5",
"express": "^4.18.1",
"helmet": "^5.1.0",
"morgan": "^1.10.0",
"npm-run-all": "^4.1.5",
"supertokens-node": "latest",
"ts-node-dev": "^2.0.0",
"typescript": "^4.7.2"
},
"devDependencies": {
"@types/cors": "^2.8.12",
"@types/morgan": "^1.9.3",
"@types/node": "^16.11.38",
"nodemon": "^2.0.16"
},
"keywords": [],
"author": "",
"license": "ISC"
}
62 changes: 62 additions & 0 deletions examples/with-thirdparty-google-onetap/backend/tsconfig.json
@@ -0,0 +1,62 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
"module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
// "outDir": "./", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
/* Advanced Options */
"skipLibCheck": true /* Skip type checking of declaration files. */,
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
}
}
1 change: 1 addition & 0 deletions examples/with-thirdparty-google-onetap/frontend/.env
@@ -0,0 +1 @@
SKIP_PREFLIGHT_CHECK=true
23 changes: 23 additions & 0 deletions examples/with-thirdparty-google-onetap/frontend/.gitignore
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*

0 comments on commit e3ca010

Please sign in to comment.