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

feat(android-sdk): fusionauth android sdk beta blog and site update #2992

Open
wants to merge 23 commits into
base: master
Choose a base branch
from

Conversation

Aaron-Ritter
Copy link
Collaborator

@Aaron-Ritter Aaron-Ritter commented Apr 4, 2024

This is the first draft for the FusionAuth Android SDK Beta Release.

The fusionauth-site edits and blogpost are from the perspective of releasing a FusionAuth Android SDK Beta, and the status is currently as follow:

@alex-fusionauth
Copy link
Contributor

@Aaron-Ritter the file layout should match our other quickstart like this one
https://github.com/FusionAuth/fusionauth-quickstart-java-android-native

Having the docker image and kickstart folder in the root and then the complete-application contain the android app.

It might also be simpler to create a new repo with the correct naming.

@Aaron-Ritter
Copy link
Collaborator Author

@Aaron-Ritter the file layout should match our other quickstart like this one https://github.com/FusionAuth/fusionauth-quickstart-java-android-native

Having the docker image and kickstart folder in the root and then the complete-application contain the android app.

Sure, we can easily change that by moving most of it in to the complete-application sub-directory. From a handling perspective inside Android Studio it was simpler to have the project in the root directory but it should work with the other structure too.

It might also be simpler to create a new repo with the correct naming.

I currently have write access to this https://github.com/FusionAuth/fusionauth-quickstart-java-android-fusionauth-sdk and the android-fusionauth-sdk. so if we could just rename fusionauth-quickstart-java-android-fusionauth-sdk to fusionauth-quickstart-kotlin-android-fusionauth-sdk the access can stay for now as it is without a change required.

@alex-fusionauth
Copy link
Contributor

I currently have write access to this https://github.com/FusionAuth/fusionauth-quickstart-java-android-fusionauth-sdk and the android-fusionauth-sdk. so if we could just rename fusionauth-quickstart-java-android-fusionauth-sdk to fusionauth-quickstart-kotlin-android-fusionauth-sdk the access can stay for now as it is without a change required.

@Aaron-Ritter

Here is the full docs for quickstarts
https://github.com/FusionAuth/fusionauth-example-template/blob/master/QUICKSTART-INSTRUCTIONS.md

For naming this should follow the same, I have put in a request to Change name from fusionauth-quickstart-java-android-fusionauth-sdk to fusionauth-quickstart-kotlin-android-native.

@Aaron-Ritter
Copy link
Collaborator Author

Aaron-Ritter commented Apr 29, 2024

@alex-fusionauth I've already moved the contents of the quickstart and will update the documentation accordingly and request a new review accordingly. We originally based it on it but were modifying it for a potential easier automated release later on but we will cross that bridge when we come to it.

Are you still reviewing the rest of the fusionauth-site PR (Blog/SDK) or do you have additional input i can consider while reworking the stuff related to quickstart?

* change repository name
* change repository structure
* further align quickstart guide to standard
@Aaron-Ritter Aaron-Ritter requested review from alex-fusionauth and removed request for mooreds May 1, 2024 09:10
@Aaron-Ritter
Copy link
Collaborator Author

@alex-fusionauth we are currently working on the FusionAuth 1.50.1 upgrade, we fixed most of it but are still looking into some unexpected behaviour FusionAuth/fusionauth-android-sdk#60.

So if you don't find anything else which needs changing we'd suggest to still wait for the merge of the PR until we fixed the incompatibility with the latest FusionAuth release and created a new version of the SDK.

Copy link
Contributor

@alex-fusionauth alex-fusionauth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small issues, some due to renaming the repo and others need to follow the guide for quickstart to get correct docker instructions.

I ran with 1.49.2 and get this after following the instructions
image

astro/src/content/blog/android-sdk-beta.mdx Outdated Show resolved Hide resolved
astro/src/content/blog/android-sdk-beta.mdx Outdated Show resolved Hide resolved
@@ -0,0 +1,104 @@
---
publish_date: 2024-03-14
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a reminder to update the date.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need as well a blog image, we don't create this :)

astro/src/content/blog/android-sdk-beta.mdx Outdated Show resolved Hide resolved
astro/src/content/blog/android-sdk-beta.mdx Outdated Show resolved Hide resolved

## Getting Started

<RemoteContent url="https://raw.githubusercontent.com/FusionAuth/fusionauth-android-sdk/main/README.md"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not positive but I think we might want to add something regarding ngrok in here the 10.0.2.2:9011 address might throw people

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is something we tested thoroughly, it's how to work locally with android emulator. And it's how the automated workflow in github works.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have the TESTING doc we're working on which deep dives in to E2E testing which makes use of the 10.0.2.2 IP and stuff like ngrok would then again cause issues with it. So to avoid confusion we will further explain what that IP means (its basically the host address from the perspective of the Android Emulator) and in what context this IP is important/used.

astro/src/content/docs/sdks/android-sdk.mdx Show resolved Hide resolved
@@ -1,5 +1,5 @@
---
title: Android Java
title: Android Java - AppAuth
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the change?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because both the AppAuth quickstart and FusionAuth SDK quickstart is live at the same time it just makes sense to specify it more clearly especially as its used in the overview of quickstarts.


### Run FusionAuth via Docker

<DockerSpinup kickstartUri={frontmatter.codeRoot + "/kickstart/kickstart.json"} />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The applicationId is incorrect as it doesn't follow the others quickstart.

Should be
e9fdb985-9173-4e01-9d73-ac2d60d1dc8e

Docker should also use

  fusionauth:
    image: fusionauth/fusionauth-app:latest

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the kickstart is not a usual one in any case as it covers more use cases.

The image i would prefer to leave on the latest tested version.

We have a manual release process of the quickstart originating from the SDK which has a fixed version, which we have planned to automate once all other workflows are stable.

Aaron-Ritter and others added 4 commits May 12, 2024 14:26
….mdx

Co-authored-by: Alex Patterson <139158618+alex-fusionauth@users.noreply.github.com>
Co-authored-by: Alex Patterson <139158618+alex-fusionauth@users.noreply.github.com>
@Aaron-Ritter
Copy link
Collaborator Author

@alex-fusionauth added a few comments, otherwise mostly merged and updated a few other additional wrong links/references.

The Not authorized issue mentioned by you above is something which we did not experience during our testing (if you checkout the repository and start it in Android Studio it should just work).

Once the new SDK version is released which is at the moment pending on FusionAuth/fusionauth-android-sdk#64, i will fully re-test the quickstart with 1.50.1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants